Resolve NUBAN

POST /api/v1/Payments/resolve-nuban

Description

This endpoint is used to resolve NUBAN (Nigerian Uniform Bank Account Number) to get details about the bank and the account holder.

Headers:

• No specific headers are required.

Path Parameters:

• version: The version of the API.

Request Body:

• nuban: The NUBAN to be resolved.

URL:

• POST: /api/v1/Payments/resolve-nuban

Response:

• 200: Success, returns the resolved NUBAN details.

Error Codes:

• 400: Bad request, the NUBAN provided is not valid.

• 404: Not found, the NUBAN provided does not exist.

• 500: Internal server error, something went wrong while processing the request.

Example Request URL:

POST /api/v1.0/Payments/resolve-nuban
Content-Type: application/json
{
  "nuban": "0123456789"
}

Example Response:

HTTP/1.1 200 OK
{
  "accountName": "John Doe",
  "bankCode": "011",
  "bankName": "First Bank of Nigeria"
}

Notes:

• The response includes the account name, bank code, and bank name associated with the provided NUBAN.

• This endpoint can be useful for verifying bank details before making a transaction.

Method: POST

/api/v1/Payments/resolve-nuban

Headers

Content-Type	Value
Content-Type	application/json

Headers

Content-Type	Value
Accept	text/plain

Body (raw)

{
  "bankCode": "<string>",
  "accountNumber": "<string>"
}

Response: 200

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": "<string>"
}